Міністерство освіти України
Національний університет «Львівська політехніка»
Кафедра автоматизованих систем управління
/
Звіт
до лабораторної роботи №6
на тему:
Розробка документації на програмне забезпечення
Лабораторна робота №6
Тема: Розробка документації на програмне забезпечення
Мета: Ознайомитись з етапом виготовлення документації на програмний продукт.
Теоретичні відомості:
Документування - це важлива частина розробки програмного забезпечення, але часто їй приділяють недостатньо уваги.
Документація на програмне забезпечення - це документи, що супроводжують деяке програмне забезпечення (ПЗ) - програму чи програмний продукт. Ці документи описують те, як працює програма або те, як її використовувати.
Документація проекту
Протягом роботи над проектом створюють велику кількість документів, наприклад: документація виробничого процесу ПЗ, керівництво, яке описує завершений проект. Документація проекту містить:
Плани, оцінки, графіки роботи - документи, розроблені менеджерами.
Схвалені документи - це інструкції для виробників.
Звіти - документи, підготовлені супервізорами. Ці документи описують роботу і її результати.
Стандарти - документи, що описують необхідні стандарти.
Робочі документи - різноманітні документи з ідеями рішень. Автори можуть бути членами команди. Якщо їх схвалять, ці документи можуть стати стандартами.
Повідомлення - примітки, коментарі, які використовуються для комунікації між членами команди.
Стандарти документації повинні стосуватися всіх аспектів проекту. Підготовка документації ділиться на стадії: попередня документація, редагування, друк, компонування копій, внесення змін у документи. Форма і зміст повинні бути ретельно підібрані відповідальними особами. Обкладинка, зміст, структура тіла документа, індекс, словник і т.п. повинні бути встановлені згідно стандарту. Потрібно визначити механізм доступу до документації, тобто слід створити бібліотеку для документів. З удосконаленням програми буде удосконалюватися і документація. Проте старі версії документів все одно залишаться. Прикладом таких документів є:
інформація про всі версії,
інформація про клієнтів і версії, які вони придбали,
ПЗ і апаратні вимоги до версії,
інформація про компоненти (класи, об'єкти, модулі), потрібні для версії,
інформація про можливі зміни версії,
інформація про виявлені помилки.
Документація повинна супроводжуватися відповідною інфраструктурою, в межах якої ця документація створюється. Під інфраструктурою ми розуміємо межі, формат і управління документацією. Загублені документи, записи, коментарі і додаткові зауваження можуть стати загрозою для проекту. Крім того, управління інфраструктурою під час проекту є дуже витратним у фінансовому і часовому плані. Тому відповідна інфраструктура повинна бути схвалена на початку проекту.
До уваги повинні бути взяті наступні пункти:
унікальна ідентифікаційна структура із заголовком, автором і номером документа;
номери послідовності і опис повинні містити:
тип документа,
номер документа,
номер версії,
дата версії,
стан;
призначення відповідальності по виробництву документа, його схваленню, редагуванню і реєстрації;
процедури введення змін; призначення відповідальних;
гарантія якості документа і особа, відповідальна за процес.
Додаткові елементи можуть бути введені в інфраструктуру, наприклад, рівень конфіденційності документів.
Виконання роботи:
Користувацька документація
Зміст
Інсталяція системи.
А. Інсталяція серверної частини.
Б. Інсталяція клієнтської частини.
В. Налаштування клієнтської частини.
Інструкція для користувачів:
А. Режим адміністратора.
Б. Режим директора.
В. Режим оператора-консультанта.
Г. Режим інтернет-клієнта.
1. Інсталяція системи.
1А. Інсталяція серверної частини.
Так як наша система «LeoTyr» працює за принципом клієнт-сервер, то сервер – це має бути окремий комп’ютер з виходом в Інтернет. Для того щоб сервер нормально функціонував потрібно виконати такі дії:
Встановити MS SQL Server;
Зупинити SQL Server використавши додаток Configuratio...